<?php
/***********************************************************************************
 * X2Engine Open Source Edition is a customer relationship management program developed by
 * X2 Engine, Inc. Copyright (C) 2011-2019 X2 Engine Inc.
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY X2ENGINE, X2ENGINE DISCLAIMS THE WARRANTY
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Affero General Public License along with
 * this program; if not, see http://www.gnu.org/licenses or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 * 
 * You can contact X2Engine, Inc. P.O. Box 610121, Redwood City,
 * California 94061, USA. or at email address contact@x2engine.com.
 * 
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 * 
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "Powered by
 * X2 Engine" logo. If the display of the logo is not reasonably feasible for
 * technical reasons, the Appropriate Legal Notices must display the words
 * "Powered by X2 Engine".
 **********************************************************************************/




/**
 * Validation for grid report form 
 */
class GridReportFormModel extends X2ReportFormModel {
    public $rowField;
    public $workflowId;
    public $columnField;
    public $cellDataType;
    public $cellDataField;

    public function rules () {
        return array_merge (
            parent::rules (),
            array (
                array (
                    'rowField, columnField, cellDataType',
                    'required',
                ),
                array (
                    'rowField, columnField', 'validateFields',
                ),
                array ('cellDataType', 'validateCellDataType'),
                array ('cellDataField', 'validateAttr', 'empty' => true),
                array ('rowField, columnField', 'validateAttr'),
            )
        );
    }

    public function attributeLabels () {
        return array_merge (parent::attributeLabels (), array (
            'rowField' => Yii::t('reports', 'Row Field'),
            'columnField' => Yii::t('reports', 'Column Field'),
            'cellDataType' => Yii::t('reports', 'Cell Data Type'),
            'workflowId' => Yii::t('reports', 'Process'),
        ));
    }

    public function validateFields ($attribute) {
        $value = $this->$attribute;
        if ($this->primaryModelType === 'Actions' && $attribute === 'stageNumber' &&
            !isset ($this->workflowId)) {

            throw new CHttpException (400, 'Invalid workflow id');
        }
    }

    public function validateCellDataType ($attribute) {
        $value = $this->$attribute;
        if (!in_array ($value, array ('count', 'sum', 'avg'))) {
            throw new CHttpException (400, 'Invalid cell data type');
        }
        // for count, the field doesn't matter, but sum and average require the value of some 
        // attribute 
        if (in_array ($value, array ('sum', 'avg')) && !isset ($this->cellDataField)) {
            throw new CHttpException (400, 'Invalid cell data field');
        }
    }
}

?>
